Fields Elements

 

Description

The following elements allow for the configuration of fields.  The fields will dictate the entry information required for activity processing.  The same field configuration is also used in screen business rules.

 

Fields Elements

Field elements are used to display and control the entry fields inside the activity.  This feature allows for flexibility of field creation and data storage according to screen, transaction, plan, fund, etc.

 

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<Fields>

The opening and closing tag of the fields section.

 

 

   <Field>

The opening and closing tag for each field being configured

 

 

        <Name>

Required;

Exact name of the field (database name). 

 

 

        <Group>

This is the name of the group (table) that should be used to obtain the value.

 

 

         <Display>

Required;

Display name of the field.  Indicates how the field will display on the screen. Spaces are allowed.

 

 

         <DataType>

Required;

DataType of the field. Defines the format of the data and functionality. Required

 

Check:  Check box field
Combo:  
Combination/drop down field
Date:  
Date field with calendar icon
Decimal:  
Displays decimal point and calculator icon
Integer:  
Formats to whole number. Displays calculator icon
Identifier:  
generates a sequence number in Client, Address, Suspense, BatchSuspense, and ActivityDetail screens.

Line:  Displays line across frame for aesthetics
Money:  
Displays dollar sign, commas, decimals and Calculator icon
Percent:  
Displays percent sign
Radio:  
Mutually exclusive options. Selecting one automatically unselects the others
Text:  
Free form entry
Blank:  
Inserts a space on screen

        <DefaultValue>

Default value of field.  If set to SYSTEMDATE, the default value will be set to the system date.

 

String, Code or Integer (depending on DataType).

        <Query>

Used with the Combo datatype to retrieve options for the combo box.

TYPE

SQL - SELECT Statment that returns the values to be displayed in the combo box. The Query must return a Code Value and a Text description.
FIXED
- Uses Options tag to fill the options.

RADIO -

            <Options>

Individual option value. Used with the Combo datatype.

 

 

                <Option>

Each option set needs to be contained in this opening and closing tag.

 

 

                   <OptionValue>

Code Value for the option. This is the value that is stored in the database.

 

 

                    <OptionText>

Text that will display in drop down box or radio buttons

 

 

   <Calculated>

Allows comparison functionality for transaction and evaluating policy data. Applicable for integer and text type fields. Limits character entry. Calculated elements override Default activities.

TYPE

SQL - allows for a SQL query to be executed with the result being the date displayed in the field.

REPLACE

Replaces one substring with another substring.

METHOD

FORCE - used to force the field to have the calculated value every time the screen is loaded.

     <Disabled>

Indicates if field should be visible but no entry is allowed.

 

Yes - field is locked down and grayed out.
No
- field is enterable.
ReadOnly
- field is locked down and grayed out.

      <Hidden>

 

 

Yes - field is hidden from user.
No -  field is
visible.

      <Length>

Limits character entry.

 

Integer. Applicable for integer and text type fields.

      <Parts>

Provides information to create a next identifier. Used with datatype Identifier.

 

String.

 

XML Example

General Example

    <Field>

        <Name>Adjustment</Name>

        <Display>Adjustment</Display>

        <DataType>Money</DataType>

        <DefaultValue>0</DefaultValue>

                  <Disabled>No</Disabled>

                  <Hidden>No</Hidden>

                  <Length>15</Length>

    </Field>

 

Line DataType Example     

   <Field>

        <Name>Line1</Name>

        <Display>Line</Display>

        <DataType>Line</DataType>

    </Field>

 

Radio DataType/OptionText population Example

    <Field>

        <Name>AccountType</Name>

        <Display>Account Type</Display>

        <DataType>Radio</DataType>

        <Query TYPE="RADIO">

            <Options>

                <Option>

                    <OptionValue>C</OptionValue>

                    <OptionText>Checking</OptionText>

                </Option>

                <Option>

                    <OptionValue>S</OptionValue>

                    <OptionText>Savings</OptionText>

                </Option>

            </Options>

        </Query>

    </Field>

 

Combo DataType/SQL population Example

<Field>

        <Name>BankStateLocation</Name>

        <Display>Bank State</Display>

        <DataType>Combo</DataType>

        <Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCodeState

             UNION SELECT '$$$Blank$$$', ' ' ORDER BY ShortDescription</Query>

    </Field>